/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.flink.connector.jdbc;

import org.apache.flink.annotation.PublicEvolving;
import org.apache.flink.connector.jdbc.internal.executor.JdbcBatchStatementExecutor;
import org.apache.flink.util.function.BiConsumerWithException;

import java.io.Serializable;
import java.sql.PreparedStatement;
import java.sql.SQLException;

/**
 * Sets {@link PreparedStatement} parameters to use in JDBC Sink based on a specific type of
 * StreamRecord. 
 * 
 * 根据特定类型的 StreamRecord设置要在JDBC Sink中使用的 {@linkPreparedStatement}参数。
 *
 * @param <T> type of payload in {@link org.apache.flink.streaming.runtime.streamrecord.StreamRecord
 *            StreamRecord}
 *  根据特定类型的 StreamRecord 设置要在JDBC Sink中使用的 {@linkPreparedStatement}参数。
 * 
 * @see JdbcBatchStatementExecutor
 */
@PublicEvolving   // 表示该接口可能会在未来版本中发生变化。
public interface JdbcStatementBuilder<T>
        extends BiConsumerWithException<PreparedStatement, T, SQLException>, Serializable {}

/**
 * 泛型接口，用于构建JDBC语句。该接口继承了BiConsumerWithException接口，并增加了Serializable接口的实现。
 * JdbcStatementBuilder接口中定义了一个accept()方法，
 * 它接受两个参数：PreparedStatement和T类型的对象，用于构建JDBC语句。
 *
 * 其中，PreparedStatement表示预编译的SQL语句，T表示传入的对象类型。该方法可以抛出SQLException异常。
 */